chore: add CHANGELOG.md check workflow on PRs - #889
Merged
Conversation
- Replace PR template with the shared SDK template - Add workflow to request review from @Iterable/sdk-team on new PRs
Fails a PR when CHANGELOG.md is not updated unless the description states "No customer facing changes" to justify skipping the changelog. Also documents the opt-out phrase in the PR template.
|
|
Qlty doesn't post analysis or coverage comments for contributors without a seat. An authorized user can grant @joaodordio a seat from this pull request's page in Qlty. |
Base automatically changed from
chore/update-pr-template-and-reviewers
to
master
August 7, 2026 13:35
|
Coverage Impact This PR will not change total coverage. 🚦 See full report on Qlty Cloud »🛟 Help
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📝 Summary
Add a CI check that fails PRs when
CHANGELOG.mdis not updated, unless the description declares "No customer facing changes".🎟️ Jira Ticket: N/A — internal CI tooling
📖 Description
Adds
.github/workflows/changelog-check, a workflow that runs on every PR (opened,edited,synchronize,reopened). The check passes when eitherCHANGELOG.mdis among the PR's changed files, or the PR description contains the phrase "No customer facing changes". Otherwise it fails with a message explaining how to resolve it.Also adds a
🧾 Changelogsection to the PR template documenting the opt-out phrase. Read-only token, no checkout, fork-safe, and not restricted by base branch so it covers every PR.🧪 How to test?
CHANGELOG.mdand omits the opt-out phrase → the check fails.CHANGELOG.md) → the check passes on the next run without a new commit.🧾 Changelog
No customer facing changes
📹 Loom recording if applicable
N/A
🐞 Github Issues solved
N/A
📚 Docs PR if applicable
N/A